Microsoft Commerce Server 2002 Software Development Kit Readme

Welcome to the Microsoft Commerce Server 2002 Software Development Kit (SDK). The SDK includes tools, headers, libraries, and sample code to jumpstart your development efforts for Microsoft® Commerce Server 2002. This readme contains a summary of the SDK contents, as well as the latest information about the SDK. For more information about the SDK, see the Software Development Kit section in the "Developer's Guide" topic in Commerce Server 2002 Help.

The SDK can be found on the product CD in \Program Files\Microsoft Commerce Server 2002\SDK. After you install Commerce Server, you can navigate to this folder from the Start menu. Click Start, point to Programs, point to Microsoft Commerce Server 2002, and then click Software Development Kit.

This document provides information about the following:

Setting Up the Commerce Server SDK

You must include the following components of the Platform SDK to build the samples in the Commerce Server 2002 SDK (choose at least these options on the Custom Installation screen of the Platform SDK installation program):

     Configuration Options (all)

     Build Environment

               Base Services (all)

               Component Services

                         COM

               Data Access Services

                         OLE DB

                         SQL Server

               Management Services

                         Microsoft Management Console

               Minimum Build Tools

               Networking and Directory Services

                         Active Directory Services Interface

               Web Services

                         Microsoft Internet Explorer

                         Microsoft Internet Information Server

               Win32 API

 

You may also want to install the following debugging tools at the same time:

     Debugging Tools

               WinDbg

               SQL Profiler

               OEM Support Tools

                         UserDump

 

To update your user INCLUDE environment variable

To update Microsoft Visual C++

To update your user INCLUDE environment variable

  1. Right-click My Computer, and then click Properties.

  2. In the System Properties dialog box, on the Advanced tab, click Environment Variables.

  3. In the Environment Variables dialog box, select the variable INCLUDE from the User variables for <username> box, and then click Edit.

  4. In the Edit User Variable dialog box, append the path to the Commerce Server 2002 SDK include directory to the value in the Variable Value box. For example:

    C:\Program Files\Microsoft Commerce Server\SDK\Include\

  5. Click OK three times to exit all three dialog boxes.

To update Microsoft Visual C++

  1. Open Microsoft Visual C++.

  2. On the Tools menu, click Options.

  3. In the Options dialog box, on the Directories tab, verify that the Include files option in the Show directories for box is selected.

  4. Click New, and then type the path to the Commerce Server 2002 SDK include directory. For example, C:\Program Files\Microsoft Commerce Server\SDK\Include.

  5. Click OK.

For more information about the Microsoft Platform SDK, see:

Code Samples

This section lists the code samples and scripts included in the Samples folder of the Microsoft Commerce Server 2002 SDK. The name of the sub-folder containing the sample code is shown in parentheses.

Sitelets

In addition to the traditional code samples provided in the Commerce Server 2002 SDK, small-scale Commerce Server 2002 sites (referred to as Sitelets) are also included. The Sitelets demonstrate how to use the API for a particular feature from either ASP or ASP.NET, without integrating that feature with the rest of the run-time services for Commerce Server 2002. This helps you isolate and understand a particular feature without having to filter out code unrelated to the task you want to perform. The following ASP-based Sitelets are included with the SDK:

The ASP-based Sitelets can be found in the Classic ASP directory of the SDK Samples directory. For example, C:\Program Files\Microsoft Commerce Server 2002\SDK\Samples\Classic ASP.

The following ASP.NET-based Sitelets are included with the SDK:

For more information about the Retail2002 Sitelet, see International Retail Site.

The ASP.NET-based Sitelets can be found in the ASPNET directory of the SDK Samples directory, for example, C:\Program Files\Microsoft Commerce Server 2002\SDK\Samples\ASPNET.

Each Sitelet directory contains a Readme.htm file with instructions for unpacking the Sitelet.

International Retail Site

The International Retail site (Retail2002.pup) is a multilingual, multicurrency business-to-business, and business-to-consumer Web site. It is similar to the Retail solution site provided for Commerce Server 2002.

The Retail2002.pup file can be found in the ASPNET directory of the SDK Samples directory, for example, C:\Program Files\Microsoft Commerce Server 2002\SDK\Samples\ASPNET\Retail2002.

Following are known issues for the International Retail site:

For more information about the International Retail site, see "Exploring the International Retail Site" in Commerce Server 2002 Help.

The International Retail site has not been tested for production use

The International Retail site is a functional example of a site created by using .NET and Commerce Server 2002 technologies. It is a sample site only and was not tested or intended to be production grade. If you use the site for your own use, it is recommended that you test the site thoroughly to be sure that the site and your extensions meet your requirements.

Anonymous checkout is disabled in the International Retail site

Anonymous checkout has been disabled on the International Retail site by limiting access to certain pages to authenticated users. This was done to address a security issue.

In this sample site, the Profiles service is used to persist the address and credit card data for authenticated and anonymous users. Due to the method used to persist user data, whenever anonymous users return to the site, their credit card data will still be usable for checkout, because it is bound to their anonymous user IDs. If another user has access to the client computer, such as at an Internet kiosk, a cached or saved page can be used to impersonate the anonymous user. The imposter could then make purchases using the credit card data without the knowledge of the previous user. The actual credit card number cannot be retrieved from the site.

You can set the Profiles service to not save the address and credit card data for anonymous users, but the length of time the data is available in the cache cannot be guaranteed.

If you choose to support anonymous checkout after addressing the security issue, you can enable anonymous checkout by modifying the Document Security section of the file Web.config. To allow anonymous access, change the authentication attribute to "false" for the following pages:

Address information for the previous user is always displayed during checkout

In order to handle cookieless checkout, the Shipping control on the Checkout.aspx page uses only the profile ticket to pull address information. Consequently, if a user has a profile ticket but is not authenticated, the shipping address information for the user will be displayed. When the anonymous user attempts to checkout, the user will have to log into the site with their credentials. The Shipping control replaces the previous address list with the list of addresses that correspond to the user account information that is provided during authentication.

The International Retail site cannot be renamed

If you rename the International Retail site while unpacking it, Microsoft® Visual Studio® .NET will not be able to successfully open the solution that is included with the site. The solution file (with the extension .sln) has been customized for the specific name of the site, Retail2002.

The International Retail site is not compatible with Windows Authentication

If you have installed Commerce Server 2002 using Windows Authentication, a default installation of the International Retail site will not function correctly. To avoid this issue, you must modify the connection strings that the site uses to connect to resources. While you are unpacking the site, you must modify all connection strings to use Microsoft® SQL Server™ user accounts. If you modify the connection strings after you unpack the site, the site will not work correctly.

You must also assign the ASPNET user account to the database role with appropriate access. The ASPNET account is a local account on the Web server. You can use the dbowner role, but to improve site security you should choose a role that enables you to assign more specific permissions. The role you select depends on the configuration of your site. For more information see "Securing Your Site" in Commerce Server 2002 Help

Tools

The Commerce Server 2002 SDK includes a set of tools to help you simplify and speed up the development process for building the following:

The following tools have been provided in the SDK. The name of the sub-folder containing the tool is shown in parentheses:

Known Issues

Following are known issues for the Commerce Server 2002 SDK:

Using the Order Queuing sample with Windows NT Authentication

To enable Windows NT Authentication with the SDK Order Queuing sample, you must do the following:

For more information about TransactionConfigReaderRole role permissions, see "Securing the TransactionConfig Database" in Commerce Server 2002 Help.

_________________________________________________________________

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the example companies, organizations, products, people and events depicted herein are fictitious and no association with any real company, organization, product, person or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft, Visual Basic, Visual C++, Visual Studio, Windows, Windows NT, and Win32 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Other product and company names mentioned herein may be the trademarks of their respective owners.

Copyright © 2002 Microsoft Corporation. All rights reserved